<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>QCNSim: QcnSim/Token.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">QCNSim
   </div>
   <div id="projectbrief">Simulator for Quake-Catcher Network</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d21be12960473ba5c51e5f9beea3525e.html">QcnSim</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">Token.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_token_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;</div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_entity_8h.html">Entity.h</a>&quot;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_simulator_globals_8h.html">SimulatorGlobals.h</a>&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_route_8h.html">Route.h</a>&quot;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="_token_8h.html#a17a408125f68aec488770e77e17f70ea">   28</a></span>&#160;<span class="preprocessor">#define DEFAULT_GENERATION_TIME std::numeric_limits&lt;double&gt;::max() // Hard-coded default generation time.</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="class_token.html">   44</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_token.html">Token</a>: <span class="keyword">public</span> <a class="code" href="class_entity.html">Entity</a> {</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="class_token.html#a8f73b3dffa8f905bdccb45abbf19aca6">   46</a></span>&#160;    <a class="code" href="class_route.html">Route</a> <a class="code" href="class_token.html#a8f73b3dffa8f905bdccb45abbf19aca6">route</a>; </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="class_token.html#ae1697de3383688ddbe8196cb392bf2ac">   47</a></span>&#160;    <span class="keywordtype">double</span> <a class="code" href="class_token.html#ae1697de3383688ddbe8196cb392bf2ac">absoluteGenerationTime</a>;  </div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="class_token.html#af5c30f0a60ca47f772e51d06bf8a54c3">   48</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="class_token.html#af5c30f0a60ca47f772e51d06bf8a54c3">recordThisRoute</a>; </div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="class_token.html#a29cd5cc1dd308d278737f1bdb293441d">   51</a></span>&#160;    <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_token.html#a29cd5cc1dd308d278737f1bdb293441d">id</a>;    </div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="class_token.html#a8125cc8499770f87f3540c81f889e039">   52</a></span>&#160;    <span class="keywordtype">int</span> <a class="code" href="class_token.html#a8125cc8499770f87f3540c81f889e039">priority</a>;       </div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    <span class="comment">// Reference member variables are driving me nuts with initialization requirements and lifetime... let&#39;s drop them and use smart pointers instead.</span></div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    <span class="comment">// Entity &amp;entity;      //!&lt; Reference to associated Entity object (typically another child of Entity class).</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="class_token.html#afefc7a53c3510da4a70ec2a9f15b9dc2">   55</a></span>&#160;    std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#afefc7a53c3510da4a70ec2a9f15b9dc2">associatedEntity</a>;  </div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="class_token.html#a1647ede32e4d927f836a0f58342d77b2">   56</a></span>&#160;    std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#a1647ede32e4d927f836a0f58342d77b2">previous</a>; </div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="class_token.html#afc3016125b848c7e88fc5dc8510762ef">   57</a></span>&#160;    std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#afc3016125b848c7e88fc5dc8510762ef">next</a>; </div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="class_token.html#afb12b6d97945606e022f63ef6f1057b9">   58</a></span>&#160;    std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#afb12b6d97945606e022f63ef6f1057b9">source</a>; </div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="class_token.html#adf59bd26155dc10e574ee552065edaa6">   59</a></span>&#160;    std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#adf59bd26155dc10e574ee552065edaa6">destination</a>; </div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;    </div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    <a class="code" href="class_token.html#a8bf8338e7e065f2a13a51fd7286ec994">Token</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="keywordtype">id</span>, <span class="keywordtype">int</span> <a class="code" href="class_token.html#a8125cc8499770f87f3540c81f889e039">priority</a>, std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#afefc7a53c3510da4a70ec2a9f15b9dc2">associatedEntity</a>, std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#afb12b6d97945606e022f63ef6f1057b9">source</a>, std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#adf59bd26155dc10e574ee552065edaa6">destination</a>);</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <a class="code" href="class_token.html#a8bf8338e7e065f2a13a51fd7286ec994">Token</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="keywordtype">id</span>, <span class="keywordtype">int</span> <a class="code" href="class_token.html#a8125cc8499770f87f3540c81f889e039">priority</a>, std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#afefc7a53c3510da4a70ec2a9f15b9dc2">associatedEntity</a>, std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#afb12b6d97945606e022f63ef6f1057b9">source</a>, std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#adf59bd26155dc10e574ee552065edaa6">destination</a>,</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;        std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#a1647ede32e4d927f836a0f58342d77b2">previous</a>, std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#afc3016125b848c7e88fc5dc8510762ef">next</a>);</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <a class="code" href="class_token.html#a8bf8338e7e065f2a13a51fd7286ec994">Token</a>(<a class="code" href="class_simulator_globals.html">SimulatorGlobals</a> &amp;simulatorGlobals, <span class="keywordtype">int</span> <a class="code" href="class_token.html#a8125cc8499770f87f3540c81f889e039">priority</a>, std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#afefc7a53c3510da4a70ec2a9f15b9dc2">associatedEntity</a>, std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#afb12b6d97945606e022f63ef6f1057b9">source</a>,</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;        std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#adf59bd26155dc10e574ee552065edaa6">destination</a>);</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    <a class="code" href="class_token.html#a8bf8338e7e065f2a13a51fd7286ec994">Token</a>(<a class="code" href="class_simulator_globals.html">SimulatorGlobals</a> &amp;simulatorGlobals, <span class="keywordtype">int</span> <a class="code" href="class_token.html#a8125cc8499770f87f3540c81f889e039">priority</a>, std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#afefc7a53c3510da4a70ec2a9f15b9dc2">associatedEntity</a>, std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#afb12b6d97945606e022f63ef6f1057b9">source</a>,</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;        std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#adf59bd26155dc10e574ee552065edaa6">destination</a>, std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#a1647ede32e4d927f836a0f58342d77b2">previous</a>, std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#afc3016125b848c7e88fc5dc8510762ef">next</a>);</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    <a class="code" href="class_token.html#a8bf8338e7e065f2a13a51fd7286ec994">Token</a>(<a class="code" href="class_simulator_globals.html">SimulatorGlobals</a> &amp;simulatorGlobals, <span class="keywordtype">int</span> <a class="code" href="class_token.html#a8125cc8499770f87f3540c81f889e039">priority</a>, std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#afefc7a53c3510da4a70ec2a9f15b9dc2">associatedEntity</a>, std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#afb12b6d97945606e022f63ef6f1057b9">source</a>,</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;        std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#adf59bd26155dc10e574ee552065edaa6">destination</a>, std::vector&lt;std::shared_ptr&lt;Entity&gt;&gt; explicitRoute);</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    <a class="code" href="class_token.html#a8bf8338e7e065f2a13a51fd7286ec994">Token</a>(<a class="code" href="class_simulator_globals.html">SimulatorGlobals</a> &amp;simulatorGlobals, <span class="keywordtype">int</span> <a class="code" href="class_token.html#a8125cc8499770f87f3540c81f889e039">priority</a>, std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#afefc7a53c3510da4a70ec2a9f15b9dc2">associatedEntity</a>, std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#afb12b6d97945606e022f63ef6f1057b9">source</a>,</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;        std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#adf59bd26155dc10e574ee552065edaa6">destination</a>, std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#a1647ede32e4d927f836a0f58342d77b2">previous</a>, std::shared_ptr&lt;Entity&gt; <a class="code" href="class_token.html#afc3016125b848c7e88fc5dc8510762ef">next</a>, std::vector&lt;std::shared_ptr&lt;Entity&gt;&gt; explicitRoute);</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    <a class="code" href="class_token.html#a3d7d59eaac1535df1433357d5d372f84">~Token</a>();</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_token.html#a1251a6a9395ed89aac82e88f4c110335">setExplicitRoute</a>(std::vector&lt;std::shared_ptr&lt;Entity&gt;&gt; explicitRoute);</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    <span class="comment">//Route&amp; getRoute();  // Route object within the Token cannot be accessible from the outside, bypassing member functions!</span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="class_token.html#a56e59f6ff2f7ad073d0456f314c3f525">getAbsoluteGenerationTime</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    <span class="keyword">virtual</span> std::vector&lt;std::shared_ptr&lt;Entity&gt;&gt; <a class="code" href="class_token.html#ae9a6cefbb86e8fdf95cb26abc2db3f72">getExplicitRoute</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_token.html#a37005881ac49bf1895a635836ae276bb">isRouteBeingRecorded</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    <span class="keyword">virtual</span> std::vector&lt;std::shared_ptr&lt;Entity&gt;&gt; <a class="code" href="class_token.html#aac76ff85d0a523ec84dc4f4d3c106f94">getRecordedRoute</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_token.html#a8cbb080826adf0f03045d6f9a89a1b66">setRecordThisRoute</a>();</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_token.html#a44dcd55816044e0c88d71612a186987f">setDoNotRecordThisRoute</a>();</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_token.html#af2f0a14dbaf5044c7712dbfbf53803eb">addHopToRecordedRoute</a>(std::shared_ptr&lt;Entity&gt; hop);</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_token.html#a006cf6391fcded1571a375fdf9748918">updateHopsFromExplicitRoute</a>(std::shared_ptr&lt;Entity&gt; currentHop);</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    </div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    <span class="comment">//Token(const Token &amp;source);</span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    <span class="comment">//Token(Token &amp;&amp;source);</span></div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;</div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;    <span class="comment">//friend void Token::swap(Token &amp;left, Token &amp;right);</span></div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;    <span class="comment">//Token &amp;operator=(Token right); // rhs as in Right Hand Side.</span></div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;</div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;    <span class="keyword">friend</span> <span class="keywordtype">bool</span> <a class="code" href="class_token.html#a2f9ac044b605d23a98ae473993b15f22">operator==</a>(<span class="keyword">const</span> <a class="code" href="class_token.html">Token</a> &amp;left, <span class="keyword">const</span> <a class="code" href="class_token.html">Token</a> &amp;right);</div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;</div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;    <span class="keyword">friend</span> <span class="keywordtype">bool</span> <a class="code" href="class_token.html#a6f52a7ce33f63dc1b326c6c5863bb670">operator!=</a>(<span class="keyword">const</span> <a class="code" href="class_token.html">Token</a> &amp;left, <span class="keyword">const</span> <a class="code" href="class_token.html">Token</a> &amp;right);</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;};                  </div>
<div class="ttc" id="class_token_html_a1647ede32e4d927f836a0f58342d77b2"><div class="ttname"><a href="class_token.html#a1647ede32e4d927f836a0f58342d77b2">Token::previous</a></div><div class="ttdeci">std::shared_ptr&lt; Entity &gt; previous</div><div class="ttdoc">Previous entity that had this token (for token routing). </div><div class="ttdef"><b>Definition:</b> <a href="_token_8h_source.html#l00056">Token.h:56</a></div></div>
<div class="ttc" id="class_token_html_afefc7a53c3510da4a70ec2a9f15b9dc2"><div class="ttname"><a href="class_token.html#afefc7a53c3510da4a70ec2a9f15b9dc2">Token::associatedEntity</a></div><div class="ttdeci">std::shared_ptr&lt; Entity &gt; associatedEntity</div><div class="ttdoc">Reference to associated Entity object (typically another child of Entity class). </div><div class="ttdef"><b>Definition:</b> <a href="_token_8h_source.html#l00055">Token.h:55</a></div></div>
<div class="ttc" id="class_token_html_ae9a6cefbb86e8fdf95cb26abc2db3f72"><div class="ttname"><a href="class_token.html#ae9a6cefbb86e8fdf95cb26abc2db3f72">Token::getExplicitRoute</a></div><div class="ttdeci">virtual std::vector&lt; std::shared_ptr&lt; Entity &gt; &gt; getExplicitRoute() const </div><div class="ttdoc">Get explicit route. </div><div class="ttdef"><b>Definition:</b> <a href="_token_8cpp_source.html#l00186">Token.cpp:186</a></div></div>
<div class="ttc" id="class_token_html_afc3016125b848c7e88fc5dc8510762ef"><div class="ttname"><a href="class_token.html#afc3016125b848c7e88fc5dc8510762ef">Token::next</a></div><div class="ttdeci">std::shared_ptr&lt; Entity &gt; next</div><div class="ttdoc">Next entity that will have to process this token (to which entity the token has to be &amp;quot;sent&amp;quot;...</div><div class="ttdef"><b>Definition:</b> <a href="_token_8h_source.html#l00057">Token.h:57</a></div></div>
<div class="ttc" id="class_route_html"><div class="ttname"><a href="class_route.html">Route</a></div><div class="ttdoc">Route class. </div><div class="ttdef"><b>Definition:</b> <a href="_route_8h_source.html#l00035">Route.h:35</a></div></div>
<div class="ttc" id="class_token_html_a2f9ac044b605d23a98ae473993b15f22"><div class="ttname"><a href="class_token.html#a2f9ac044b605d23a98ae473993b15f22">Token::operator==</a></div><div class="ttdeci">friend bool operator==(const Token &amp;left, const Token &amp;right)</div><div class="ttdoc">Comparator, non-member function. </div><div class="ttdef"><b>Definition:</b> <a href="_token_8cpp_source.html#l00308">Token.cpp:308</a></div></div>
<div class="ttc" id="class_token_html_a56e59f6ff2f7ad073d0456f314c3f525"><div class="ttname"><a href="class_token.html#a56e59f6ff2f7ad073d0456f314c3f525">Token::getAbsoluteGenerationTime</a></div><div class="ttdeci">virtual double getAbsoluteGenerationTime() const </div><div class="ttdoc">Gets the (reference to) route attached to token. </div><div class="ttdef"><b>Definition:</b> <a href="_token_8cpp_source.html#l00177">Token.cpp:177</a></div></div>
<div class="ttc" id="class_token_html_ae1697de3383688ddbe8196cb392bf2ac"><div class="ttname"><a href="class_token.html#ae1697de3383688ddbe8196cb392bf2ac">Token::absoluteGenerationTime</a></div><div class="ttdeci">double absoluteGenerationTime</div><div class="ttdoc">Absolute generation timestamp for this token (i.e., the clock time this token was generated)...</div><div class="ttdef"><b>Definition:</b> <a href="_token_8h_source.html#l00047">Token.h:47</a></div></div>
<div class="ttc" id="class_token_html_afb12b6d97945606e022f63ef6f1057b9"><div class="ttname"><a href="class_token.html#afb12b6d97945606e022f63ef6f1057b9">Token::source</a></div><div class="ttdeci">std::shared_ptr&lt; Entity &gt; source</div><div class="ttdoc">Source entity of this token. </div><div class="ttdef"><b>Definition:</b> <a href="_token_8h_source.html#l00058">Token.h:58</a></div></div>
<div class="ttc" id="_entity_8h_html"><div class="ttname"><a href="_entity_8h.html">Entity.h</a></div></div>
<div class="ttc" id="class_token_html"><div class="ttname"><a href="class_token.html">Token</a></div><div class="ttdoc">Token class. </div><div class="ttdef"><b>Definition:</b> <a href="_token_8h_source.html#l00044">Token.h:44</a></div></div>
<div class="ttc" id="class_token_html_af2f0a14dbaf5044c7712dbfbf53803eb"><div class="ttname"><a href="class_token.html#af2f0a14dbaf5044c7712dbfbf53803eb">Token::addHopToRecordedRoute</a></div><div class="ttdeci">virtual void addHopToRecordedRoute(std::shared_ptr&lt; Entity &gt; hop)</div><div class="ttdoc">Record hop within recorded route, if flag is set. </div><div class="ttdef"><b>Definition:</b> <a href="_token_8cpp_source.html#l00231">Token.cpp:231</a></div></div>
<div class="ttc" id="class_token_html_af5c30f0a60ca47f772e51d06bf8a54c3"><div class="ttname"><a href="class_token.html#af5c30f0a60ca47f772e51d06bf8a54c3">Token::recordThisRoute</a></div><div class="ttdeci">bool recordThisRoute</div><div class="ttdoc">True: route followed by token/PDU must be recorded. False: do not record route followed by token/PDU...</div><div class="ttdef"><b>Definition:</b> <a href="_token_8h_source.html#l00048">Token.h:48</a></div></div>
<div class="ttc" id="class_token_html_a8bf8338e7e065f2a13a51fd7286ec994"><div class="ttname"><a href="class_token.html#a8bf8338e7e065f2a13a51fd7286ec994">Token::Token</a></div><div class="ttdeci">Token(unsigned int id, int priority, std::shared_ptr&lt; Entity &gt; associatedEntity, std::shared_ptr&lt; Entity &gt; source, std::shared_ptr&lt; Entity &gt; destination)</div><div class="ttdoc">Constructor with parameters, but previous and next. </div><div class="ttdef"><b>Definition:</b> <a href="_token_8cpp_source.html#l00034">Token.cpp:34</a></div></div>
<div class="ttc" id="_route_8h_html"><div class="ttname"><a href="_route_8h.html">Route.h</a></div></div>
<div class="ttc" id="class_entity_html"><div class="ttname"><a href="class_entity.html">Entity</a></div><div class="ttdoc">Entity class. </div><div class="ttdef"><b>Definition:</b> <a href="_entity_8h_source.html#l00029">Entity.h:29</a></div></div>
<div class="ttc" id="class_token_html_a44dcd55816044e0c88d71612a186987f"><div class="ttname"><a href="class_token.html#a44dcd55816044e0c88d71612a186987f">Token::setDoNotRecordThisRoute</a></div><div class="ttdeci">virtual void setDoNotRecordThisRoute()</div><div class="ttdoc">Unset flag to record the route followed by token (set to FALSE). </div><div class="ttdef"><b>Definition:</b> <a href="_token_8cpp_source.html#l00218">Token.cpp:218</a></div></div>
<div class="ttc" id="_simulator_globals_8h_html"><div class="ttname"><a href="_simulator_globals_8h.html">SimulatorGlobals.h</a></div></div>
<div class="ttc" id="class_token_html_a8cbb080826adf0f03045d6f9a89a1b66"><div class="ttname"><a href="class_token.html#a8cbb080826adf0f03045d6f9a89a1b66">Token::setRecordThisRoute</a></div><div class="ttdeci">virtual void setRecordThisRoute()</div><div class="ttdoc">Set flag to record the route followed by token to TRUE. </div><div class="ttdef"><b>Definition:</b> <a href="_token_8cpp_source.html#l00211">Token.cpp:211</a></div></div>
<div class="ttc" id="class_token_html_a1251a6a9395ed89aac82e88f4c110335"><div class="ttname"><a href="class_token.html#a1251a6a9395ed89aac82e88f4c110335">Token::setExplicitRoute</a></div><div class="ttdeci">virtual void setExplicitRoute(std::vector&lt; std::shared_ptr&lt; Entity &gt;&gt; explicitRoute)</div><div class="ttdoc">Set the explicit route for this token and erases previously recorded route. </div><div class="ttdef"><b>Definition:</b> <a href="_token_8cpp_source.html#l00155">Token.cpp:155</a></div></div>
<div class="ttc" id="class_token_html_a37005881ac49bf1895a635836ae276bb"><div class="ttname"><a href="class_token.html#a37005881ac49bf1895a635836ae276bb">Token::isRouteBeingRecorded</a></div><div class="ttdeci">virtual bool isRouteBeingRecorded() const </div><div class="ttdoc">Get value of flag recordThisRoute. </div><div class="ttdef"><b>Definition:</b> <a href="_token_8cpp_source.html#l00195">Token.cpp:195</a></div></div>
<div class="ttc" id="class_simulator_globals_html"><div class="ttname"><a href="class_simulator_globals.html">SimulatorGlobals</a></div><div class="ttdoc">Simulator-scope variables and parameters. </div><div class="ttdef"><b>Definition:</b> <a href="_simulator_globals_8h_source.html#l00158">SimulatorGlobals.h:158</a></div></div>
<div class="ttc" id="class_token_html_a006cf6391fcded1571a375fdf9748918"><div class="ttname"><a href="class_token.html#a006cf6391fcded1571a375fdf9748918">Token::updateHopsFromExplicitRoute</a></div><div class="ttdeci">virtual void updateHopsFromExplicitRoute(std::shared_ptr&lt; Entity &gt; currentHop)</div><div class="ttdoc">Update previous/next hops from the explicit route vector to prepare the token to be forwarded within ...</div><div class="ttdef"><b>Definition:</b> <a href="_token_8cpp_source.html#l00248">Token.cpp:248</a></div></div>
<div class="ttc" id="class_token_html_adf59bd26155dc10e574ee552065edaa6"><div class="ttname"><a href="class_token.html#adf59bd26155dc10e574ee552065edaa6">Token::destination</a></div><div class="ttdeci">std::shared_ptr&lt; Entity &gt; destination</div><div class="ttdoc">Destination entity of this token. </div><div class="ttdef"><b>Definition:</b> <a href="_token_8h_source.html#l00059">Token.h:59</a></div></div>
<div class="ttc" id="class_token_html_a3d7d59eaac1535df1433357d5d372f84"><div class="ttname"><a href="class_token.html#a3d7d59eaac1535df1433357d5d372f84">Token::~Token</a></div><div class="ttdeci">~Token()</div><div class="ttdef"><b>Definition:</b> <a href="_token_8cpp_source.html#l00142">Token.cpp:142</a></div></div>
<div class="ttc" id="class_token_html_a29cd5cc1dd308d278737f1bdb293441d"><div class="ttname"><a href="class_token.html#a29cd5cc1dd308d278737f1bdb293441d">Token::id</a></div><div class="ttdeci">unsigned int id</div><div class="ttdoc">Token unique ID. </div><div class="ttdef"><b>Definition:</b> <a href="_token_8h_source.html#l00051">Token.h:51</a></div></div>
<div class="ttc" id="class_token_html_a6f52a7ce33f63dc1b326c6c5863bb670"><div class="ttname"><a href="class_token.html#a6f52a7ce33f63dc1b326c6c5863bb670">Token::operator!=</a></div><div class="ttdeci">friend bool operator!=(const Token &amp;left, const Token &amp;right)</div><div class="ttdoc">Not-equal operator, non-member function. </div><div class="ttdef"><b>Definition:</b> <a href="_token_8cpp_source.html#l00331">Token.cpp:331</a></div></div>
<div class="ttc" id="class_token_html_a8f73b3dffa8f905bdccb45abbf19aca6"><div class="ttname"><a href="class_token.html#a8f73b3dffa8f905bdccb45abbf19aca6">Token::route</a></div><div class="ttdeci">Route route</div><div class="ttdoc">Route object to provide explicit routing for the token, or to record followed routes. </div><div class="ttdef"><b>Definition:</b> <a href="_token_8h_source.html#l00046">Token.h:46</a></div></div>
<div class="ttc" id="class_token_html_aac76ff85d0a523ec84dc4f4d3c106f94"><div class="ttname"><a href="class_token.html#aac76ff85d0a523ec84dc4f4d3c106f94">Token::getRecordedRoute</a></div><div class="ttdeci">virtual std::vector&lt; std::shared_ptr&lt; Entity &gt; &gt; getRecordedRoute() const </div><div class="ttdoc">Get recorded route so far. </div><div class="ttdef"><b>Definition:</b> <a href="_token_8cpp_source.html#l00204">Token.cpp:204</a></div></div>
<div class="ttc" id="class_token_html_a8125cc8499770f87f3540c81f889e039"><div class="ttname"><a href="class_token.html#a8125cc8499770f87f3540c81f889e039">Token::priority</a></div><div class="ttdeci">int priority</div><div class="ttdoc">Token priority. Higher priority, higher number. </div><div class="ttdef"><b>Definition:</b> <a href="_token_8h_source.html#l00052">Token.h:52</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jan 6 2014 12:30:37 for QCNSim by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
